Update and clarify aspects in documentation #111
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sadielbartholomew
added
the
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #111 +/- ##
=======================================
Coverage 89.23% 89.23%
=======================================
Files 14 14
Lines 548 548
=======================================
Hits 489 489
Misses 59 59 ☔ View full report in Codecov by Sentry. |
sadielbartholomew
requested review from
tlestang,
abhidg and
andreww
and removed request for
tlestang and
abhidg
andreww
approved these changes
Aug 23, 2024
There was a problem hiding this comment.
Looks good to me. One thing I'm unclear about is if the documentation on readthedocs will keep up with our main branch, or keeps versions of the documentation for releases, or what. Not an issue for this PR, but probably needs looking at.
Anyhow, committing this quickly seems sensible.
|
Go ahead and merge - that will tell us for sure what the merge conflicts are for #110. I think they would be easy to fix. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor updates to the CATS documentation, including:
config.yamlin the current directory' when strictly it just needs a YAML extension so the same with.ymlis also acceptable;Hopefully these are fairly self-explanatory suggestions, but please feel free to question.